
This document should show the first steps with QuarterBukkit. If you want to read the complete tutorial, go on http://github.com/QuarterCode/QuarterBukkit/wiki.

The Download Package
====================

If you didn't download the package from http://dev.bukkit.org/server-mods/quarterbukkit, you may downloaded a fake (maybe with viruses).

Your downloaded content:

|---------------------------------------------------------------------------------|
| File              | Description                                                 |
|-------------------|-------------------------------------------------------------|
| QuarterBukkit.jar | The main jar (put this in your classpath)                   |
| /Integration      | You have to use this classes for the integration, see below |
| /Source           | The Source-Code                                             |
| /JavaDoc          | The API Documentation with JavaDoc (you'll need this!)      |
| /Build            | All compiled classes                                        |
|---------------------------------------------------------------------------------|

Integrate QuarterBukkit into your plugin
========================================

Simply put all classes from /Integration into a package of your plugin (I would use a util-package) and call QuarterBukkitIntegration.integrate() in your onLoad()-method This should look like this:

    @Override
    public void onLoad() {

        QuarterBukkitIntegration.integrate();

        // Your code here
    }

Then add QuarterBukkit to your softdepend-list in the plugin.yml. If you don't have this entry, simply add this line:

    softdepend: [QuarterBukkit]

And you're done! Now you can use all amazing QuarterBukkit-functions! See JavaDoc (Download Package) and [API-Page](API Overview) for more information.